Fetch Scenario details

Fetches comprehensive information about test Scenarios within your project. This endpoint supports:

Pagination: Control response size with configurable page numbers and sizes (max 25 items per page)
Flexible Filtering: Filter by specific Scenario IDs or requirement traceability keys
Optional Detailed Information: Selectively include additional details such as custom fields, step details, requirement traceability, and scenario traceability in the response
User-Specific Version View: Results reflect the requesting user's current version of the entities.

POST{accelqLoginUrl}/awb/api/2.0/{tenantCode}/{projectCode}/scn/scenarios/{scenarioType}/fetch-details

Headers

Header	Value
`user_id`	Login username (email)
`api_key`	API key of the user for authentication
`Content-Type`	application/json
`Accept`	application/json

Parameters

Parameter	Type	Required	Description
`accelqLoginUrl`	string	Yes	The AccelQ login URL for API access.
`tenantCode`	string	Yes	Tenant code for identifying the organization.
`projectCode`	string	Yes	Project Code found under Auth properties of ACCELQ User Profile
`scenarioType`	string	Yes	Scenario Type
`pageNumber`	integer	No	Page number for pagination. Use this to navigate through large result sets efficiently.
`pageSize`	integer	No	Number of Scenarios to return per page. Constraints: - Minimum: 1 - Maximum: 25 - Default: 20
`user_id`	string	Yes	Login username (email)
`api_key`	string	Yes	API key of the user for authentication

Request Body

json

{
  "filter": {
    "scenarioIds": [
      1,
      3,
      8
    ],
    "requirementKeys": [
      "TP-12",
      "TP-59"
    ]
  },
  "additionalDetails": {
    "steps": true,
    "requirementTraceability": true,
    "customFields": true,
    "scenarioTraceability": true
  }
}

Responses

200 - Successful retrieval of Scenario details with comprehensive information about filtered Scenarios.

json

{
  "page": 1,
  "pageSize": 10,
  "totalPages": 1,
  "totalCount": 3,
  "results": [
    {
      "id": 1,
      "name": "Ticket Booking",
      "description": "Scenario to test Ticket Booking functionality",
      "testCasesCount": 15,
      "traceabilityCount": 7,
      "status": "New",
      "createdBy": "Tenant Admin",
      "createdTimestamp": "2025-10-08T09:24:22Z",
      "lastModifiedBy": "Verni Cooper",
      "lastModifiedTimestamp": "2025-10-19T17:59:05Z",
      "customFields": {
        "Priority": "Low",
        "New List": "true"
      },
      "tags": [
        "To be Reviewed",
        "Smoke"
      ]
    },
    {
      "id": 3,
      "name": "User Registration",
      "description": "Scenario to test new user registration flow",
      "testCasesCount": 8,
      "traceabilityCount": 1,
      "status": "Completed",
      "createdBy": "John Citadel",
      "createdTimestamp": "2025-10-08T09:24:22Z",
      "lastModifiedBy": "Tenant Admin",
      "lastModifiedTimestamp": "2025-10-19T17:59:05Z",
      "customFields": {
        "Priority": "High",
        "New List": "true"
      },
      "tags": [
        "Regression",
        "Critical"
      ]
    },
    {
      "id": 8,
      "name": "Logout",
      "description": "Scenario to test user logout",
      "testCasesCount": 15,
      "traceabilityCount": 7,
      "status": "New",
      "createdBy": "Tenant Admin",
      "createdTimestamp": "2025-10-08T09:24:22Z",
      "lastModifiedBy": "Tenant Admin",
      "lastModifiedTimestamp": "2025-10-19T17:59:05Z",
      "customFields": {
        "Priority": "Low",
        "New List": "true"
      },
      "tags": [
        "Smoke"
      ]
    }
  ]
}

401 - Unauthorized - Invalid authentication credentials

json

{
  "error": "Invalid user credentials or API key"
}

403 - Forbidden

json

{
  "error": "User does not have authorization to access this feature"
}

500 - Internal Server Error

json

{
  "error": "Error occurred while retrieving Scenarios details"
}

cURL Command Builder

URL Parameters

accelqLoginUrl (string) *

tenantCode (string) *

projectCode (string) *

scenarioType (string) *

pageNumber (integer)

pageSize (integer)

Headers

user_id (string) *

api_key (string) *

Request Sample (cURL)

curl -X POST "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/${{projectCode}}/scn/scenarios/${{scenarioType}}/fetch-details?pageNumber=${{pageNumber}}&pageSize=${{pageSize}}" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "filter": {
    "scenarioIds": [
      1,
      3,
      8
    ],
    "requirementKeys": [
      "TP-12",
      "TP-59"
    ]
  },
  "additionalDetails": {
    "steps": true,
    "requirementTraceability": true,
    "customFields": true,
    "scenarioTraceability": true
  }
}'